home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1994 August: Tool Chest / Dev.CD Aug 94.toast / Tool Chest / Interfaces / MPW Interfaces / PInterfaces / Editions.p < prev    next >
Encoding:
Text File  |  1993-09-17  |  12.3 KB  |  340 lines  |  [TEXT/MPS ]
  1. {
  2.     File:        Editions.p
  3.  
  4.     Copyright:    © 1983-1993 by Apple Computer, Inc.
  5.                 All rights reserved.
  6.  
  7.     Version:    System 7.1 for ETO #11
  8.     Created:    Tuesday, March 30, 1993 18:00
  9.  
  10. }
  11.  
  12. {$IFC UNDEFINED UsingIncludes}
  13. {$SETC UsingIncludes := 0}
  14. {$ENDC}
  15.  
  16. {$IFC NOT UsingIncludes}
  17.     UNIT Editions;
  18.     INTERFACE
  19. {$ENDC}
  20.  
  21. {$IFC UNDEFINED UsingEditions}
  22. {$SETC UsingEditions := 1}
  23.  
  24. {$I+}
  25. {$SETC EditionsIncludes := UsingIncludes}
  26. {$SETC UsingIncludes := 1}
  27. {$IFC UNDEFINED UsingMemory}
  28. {$I $$Shell(PInterfaces)Memory.p}
  29. {$ENDC}
  30. {$IFC UNDEFINED UsingTypes}
  31. {$I $$Shell(PInterfaces)Types.p}
  32. {$ENDC}
  33. {$IFC UNDEFINED UsingFiles}
  34. {$I $$Shell(PInterfaces)Files.p}
  35. {$ENDC}
  36. {$IFC UNDEFINED UsingAliases}
  37. {$I $$Shell(PInterfaces)Aliases.p}
  38. {$ENDC}
  39. {$SETC UsingIncludes := EditionsIncludes}
  40.  
  41. CONST
  42.  
  43. { resource types  }
  44. rSectionType = 'sect';                      { ResType of saved SectionRecords }
  45.  
  46. { section types }
  47. stSubscriber = $01;
  48. stPublisher = $0A;
  49.  
  50. sumAutomatic = 0;                           { subscriber update mode - Automatically     }
  51. sumManual = 1;                              { subscriber update mode - Manually }
  52. pumOnSave = 0;                              { publisher update mode - OnSave            }
  53. pumManual = 1;                              { publisher update mode - Manually }
  54.  
  55. kPartsNotUsed = 0;
  56. kPartNumberUnknown = -1;                    { misc }
  57.  
  58. kPreviewWidth = 120;
  59. kPreviewHeight = 120;
  60.  
  61. kPublisherDocAliasFormat = 'alis';
  62. kPreviewFormat = 'prvw';
  63. kFormatListFormat = 'fmts';
  64.  
  65. { bits for formatsMask }
  66. kPICTformatMask = 1;
  67. kTEXTformatMask = 2;
  68. ksndFormatMask = 4;
  69.  
  70. { Finder types for edition files }
  71. kPICTEditionFileType = 'edtp';
  72. kTEXTEditionFileType = 'edtt';
  73. ksndEditionFileType = 'edts';
  74. kUnknownEditionFileType = 'edtu';
  75.  
  76. { pseudo-item hits for dialogHooks 
  77.  the first if for NewPublisher or NewSubscriber Dialogs }
  78. emHookRedrawPreview = 150;
  79.  
  80. { the following are for SectionOptions Dialog }
  81. emHookCancelSection = 160;
  82. emHookGoToPublisher = 161;
  83. emHookGetEditionNow = 162;
  84. emHookSendEditionNow = 162;
  85. emHookManualUpdateMode = 163;
  86. emHookAutoUpdateMode = 164;
  87.  
  88. { the refcon field of the dialog record during a modalfilter 
  89.  or dialoghook contains one the following }
  90. emOptionsDialogRefCon = 'optn';
  91. emCancelSectionDialogRefCon = 'cncl';
  92. emGoToPubErrDialogRefCon = 'gerr';
  93. kFormatLengthUnknown = -1;
  94.  
  95. TYPE
  96. SectionType = SignedByte;                   { one byte, stSubscriber or stPublisher }
  97. TimeStamp = LONGINT;                        { seconds since 1904 }
  98. FormatType = PACKED ARRAY [1..4] OF CHAR;   { similar to ResType as used by scrap mgr }
  99. EditionRefNum = Handle;                     { used in Edition I/O }
  100. { update modes }
  101. UpdateMode = INTEGER;                       { sumAutomatic, pumSuspend, etc }
  102.  
  103. SectionPtr = ^SectionRecord;
  104. SectionHandle = ^SectionPtr;
  105. SectionRecord = RECORD
  106.     version: SignedByte;                    { always 0x01 in system 7.0 }
  107.     kind: SectionType;                      { stSubscriber or stPublisher }
  108.     mode: UpdateMode;                       { auto or manual }
  109.     mdDate: TimeStamp;                      { last change in document }
  110.     sectionID: LONGINT;                     { app. specific, unique per document }
  111.     refCon: LONGINT;                        { application specific }
  112.     alias: AliasHandle;                     { handle to Alias Record }
  113.     subPart: LONGINT;                       { which part of container file }
  114.     nextSection: SectionHandle;             { for linked list of app's Sections }
  115.     controlBlock: Handle;                   { used internally }
  116.     refNum: EditionRefNum;                  { used internally }
  117.     END;
  118.  
  119. EditionContainerSpecPtr = ^EditionContainerSpec;
  120. EditionContainerSpec = RECORD
  121.     theFile: FSSpec;
  122.     theFileScript: ScriptCode;
  123.     thePart: LONGINT;
  124.     thePartName: Str31;
  125.     thePartScript: ScriptCode;
  126.     END;
  127.  
  128. EditionInfoRecord = RECORD
  129.     crDate: TimeStamp;                      { date EditionContainer was created }
  130.     mdDate: TimeStamp;                      { date of last change }
  131.     fdCreator: OSType;                      { file creator }
  132.     fdType: OSType;                         { file type }
  133.     container: EditionContainerSpec;        { the Edition }
  134.     END;
  135.  
  136. NewPublisherReply = RECORD
  137.     canceled: BOOLEAN;                      { O }
  138.     replacing : BOOLEAN;
  139.     usePart: BOOLEAN;                       { I }
  140.     preview: Handle;                        { I }
  141.     previewFormat: FormatType;              { I }
  142.     container: EditionContainerSpec;        { I/O }
  143.     END;
  144.  
  145. NewSubscriberReply = RECORD
  146.     canceled: BOOLEAN;                      { O }
  147.     formatsMask: SignedByte;
  148.     container: EditionContainerSpec;        {I/O}
  149.     END;
  150.  
  151. SectionOptionsReply = RECORD
  152.     canceled: BOOLEAN;                      { O }
  153.     changed: BOOLEAN;                       { O }
  154.     sectionH: SectionHandle;                { I }
  155.     action: ResType;                        { O }
  156.     END;
  157.  
  158.  
  159. ExpModalFilterProcPtr = ProcPtr;            { FUNCTION Filter(theDialog: DialogPtr; VAR theEvent: EventRecord; itemOffset: INTEGER; VAR itemHit: INTEGER; yourDataPtr: Ptr): BOOLEAN; }
  160. ExpDlgHookProcPtr = ProcPtr;                { FUNCTION Hook(itemOffset, item: INTEGER; theDialog: DialogPtr; yourDataPtr: Ptr): INTEGER; }
  161.  
  162. FormatIOVerb = (ioHasFormat,ioReadFormat,ioNewFormat,ioWriteFormat);
  163.  
  164.  
  165. FormatIOParamBlock = RECORD
  166.     ioRefNum: LONGINT;
  167.     format: FormatType;
  168.     formatIndex: LONGINT;
  169.     offset: LONGINT;
  170.     buffPtr: Ptr;
  171.     buffLen: LONGINT;
  172.     END;
  173.  
  174.  
  175. FormatIOProcPtr = ProcPtr;                  { FUNCTION IO(selector: FormatIOVerb; VAR PB: FormatIOParamBlock): OSErr; }
  176.  
  177. EditionOpenerVerb = (eoOpen,eoClose,eoOpenNew,eoCloseNew,eoCanSubscribe);
  178.  
  179.  
  180. EditionOpenerParamBlock = RECORD
  181.     info: EditionInfoRecord;
  182.     sectionH: SectionHandle;
  183.     document: FSSpecPtr;
  184.     fdCreator: OSType;
  185.     ioRefNum: LONGINT;
  186.     ioProc: FormatIOProcPtr;
  187.     success: BOOLEAN;
  188.     formatsMask: SignedByte;
  189.     END;
  190.  
  191.  
  192. EditionOpenerProcPtr = ProcPtr;             { FUNCTION Opener(selector: EditionOpenerVerb; VAR PB: EditionOpenerParamBlock): OSErr; }
  193.  
  194. CONST
  195.  
  196. { 
  197.     Section events now arrive in the message buffer using the AppleEvent format.
  198.     The direct object parameter is an aeTemporaryIDParamType ('tid '). The temporary
  199.     ID's type is rSectionType ('sect') and the 32-bit value is a SectionHandle.
  200.     The following is a sample buffer
  201.     
  202.     name            offset    contents
  203.     ----            ------    --------
  204.     
  205.     header            0        'aevt'
  206.     majorVersion    4        0x01
  207.     minorVersion    6        0x01
  208.     endOfMetaData    8        ';;;;' 
  209.     directObjKey    12        '----' 
  210.     paramType        16        'tid ' 
  211.     paramLength        20        0x0008 
  212.     tempIDType        24        'sect' 
  213.     tempID             28        the SectionHandle <-- this is want you want}
  214.  
  215. sectionEventMsgClass = 'sect';
  216. sectionReadMsgID = 'read';
  217. sectionWriteMsgID = 'writ';
  218. sectionScrollMsgID = 'scrl';
  219. sectionCancelMsgID = 'cncl';
  220.  
  221. FUNCTION InitEditionPack: OSErr;
  222.     INLINE $3F3C,$0011,$303C,$0100,$A82D;
  223. FUNCTION NewSection(container: EditionContainerSpec;
  224.                     sectionDocument: FSSpecPtr;
  225.                     kind: SectionType;
  226.                     sectionID: LONGINT;
  227.                     initalMode: UpdateMode;
  228.                     VAR sectionH: SectionHandle): OSErr;
  229.     INLINE $303C,$0A02,$A82D;
  230. FUNCTION RegisterSection(sectionDocument: FSSpec;
  231.                          sectionH: SectionHandle;
  232.                          VAR aliasWasUpdated: BOOLEAN): OSErr;
  233.     INLINE $303C,$0604,$A82D;
  234. FUNCTION UnRegisterSection(sectionH: SectionHandle): OSErr;
  235.     INLINE $303C,$0206,$A82D;
  236. FUNCTION IsRegisteredSection(sectionH: SectionHandle): OSErr;
  237.     INLINE $303C,$0208,$A82D;
  238. FUNCTION AssociateSection(sectionH: SectionHandle;
  239.                           newSectionDocument: FSSpecPtr): OSErr;
  240.     INLINE $303C,$040C,$A82D;
  241. FUNCTION CreateEditionContainerFile(editionFile: FSSpec;
  242.                                     fdCreator: OSType;
  243.                                     editionFileNameScript: ScriptCode): OSErr;
  244.     INLINE $303C,$050E,$A82D;
  245. FUNCTION DeleteEditionContainerFile(editionFile: FSSpec): OSErr;
  246.     INLINE $303C,$0210,$A82D;
  247. FUNCTION OpenEdition(subscriberSectionH: SectionHandle;
  248.                      VAR refNum: EditionRefNum): OSErr;
  249.     INLINE $303C,$0412,$A82D;
  250. FUNCTION OpenNewEdition(publisherSectionH: SectionHandle;
  251.                         fdCreator: OSType;
  252.                         publisherSectionDocument: FSSpecPtr;
  253.                         VAR refNum: EditionRefNum): OSErr;
  254.     INLINE $303C,$0814,$A82D;
  255. FUNCTION CloseEdition(whichEdition: EditionRefNum;
  256.                       successful: BOOLEAN): OSErr;
  257.     INLINE $303C,$0316,$A82D;
  258. FUNCTION EditionHasFormat(whichEdition: EditionRefNum;
  259.                           whichFormat: FormatType;
  260.                           VAR formatSize: Size): OSErr;
  261.     INLINE $303C,$0618,$A82D;
  262. FUNCTION ReadEdition(whichEdition: EditionRefNum;
  263.                      whichFormat: FormatType;
  264.                      buffPtr: UNIV Ptr;
  265.                      VAR buffLen: Size): OSErr;
  266.     INLINE $303C,$081A,$A82D;
  267. FUNCTION WriteEdition(whichEdition: EditionRefNum;
  268.                       whichFormat: FormatType;
  269.                       buffPtr: UNIV Ptr;
  270.                       buffLen: Size): OSErr;
  271.     INLINE $303C,$081C,$A82D;
  272. FUNCTION GetEditionFormatMark(whichEdition: EditionRefNum;
  273.                               whichFormat: FormatType;
  274.                               VAR currentMark: LONGINT): OSErr;
  275.     INLINE $303C,$061E,$A82D;
  276. FUNCTION SetEditionFormatMark(whichEdition: EditionRefNum;
  277.                               whichFormat: FormatType;
  278.                               setMarkTo: LONGINT): OSErr;
  279.     INLINE $303C,$0620,$A82D;
  280. FUNCTION GetEditionInfo(sectionH: SectionHandle;
  281.                         VAR editionInfo: EditionInfoRecord): OSErr;
  282.     INLINE $303C,$0422,$A82D;
  283. FUNCTION GoToPublisherSection(container: EditionContainerSpec): OSErr;
  284.     INLINE $303C,$0224,$A82D;
  285. FUNCTION GetLastEditionContainerUsed(VAR container: EditionContainerSpec): OSErr;
  286.     INLINE $303C,$0226,$A82D;
  287. FUNCTION GetStandardFormats(container: EditionContainerSpec;
  288.                             VAR previewFormat: FormatType;
  289.                             preview: Handle;
  290.                             publisherAlias: Handle;
  291.                             formats: Handle): OSErr;
  292.     INLINE $303C,$0A28,$A82D;
  293. FUNCTION GetEditionOpenerProc(VAR opener: EditionOpenerProcPtr): OSErr;
  294.     INLINE $303C,$022A,$A82D;
  295. FUNCTION SetEditionOpenerProc(opener: EditionOpenerProcPtr): OSErr;
  296.     INLINE $303C,$022C,$A82D;
  297. FUNCTION CallEditionOpenerProc(selector: EditionOpenerVerb;
  298.                                VAR PB: EditionOpenerParamBlock;
  299.                                routine: EditionOpenerProcPtr): OSErr;
  300.     INLINE $303C,$052E,$A82D;
  301. FUNCTION CallFormatIOProc(selector: FormatIOVerb;
  302.                           VAR PB: FormatIOParamBlock;
  303.                           routine: FormatIOProcPtr): OSErr;
  304.     INLINE $303C,$0530,$A82D;
  305. FUNCTION NewSubscriberDialog(VAR reply: NewSubscriberReply): OSErr;
  306.     INLINE $303C,$0232,$A82D;
  307. FUNCTION NewSubscriberExpDialog(VAR reply: NewSubscriberReply;
  308.                                 where: Point;
  309.                                 expansionDITLresID: INTEGER;
  310.                                 dlgHook: ExpDlgHookProcPtr;
  311.                                 filterProc: ExpModalFilterProcPtr;
  312.                                 yourDataPtr:UNIV Ptr): OSErr;
  313.     INLINE $303C,$0B34,$A82D;
  314. FUNCTION NewPublisherDialog(VAR reply: NewPublisherReply): OSErr;
  315.     INLINE $303C,$0236,$A82D;
  316. FUNCTION NewPublisherExpDialog(VAR reply: NewPublisherReply;
  317.                                where: Point;
  318.                                expansionDITLresID: INTEGER;
  319.                                dlgHook: ExpDlgHookProcPtr;
  320.                                filterProc: ExpModalFilterProcPtr;
  321.                                yourDataPtr: UNIV Ptr): OSErr;
  322.     INLINE $303C,$0B38,$A82D;
  323. FUNCTION SectionOptionsDialog(VAR reply: SectionOptionsReply): OSErr;
  324.     INLINE $303C,$023A,$A82D;
  325. FUNCTION SectionOptionsExpDialog(VAR reply: SectionOptionsReply;
  326.                                  where: Point;
  327.                                  expansionDITLresID: INTEGER;
  328.                                  dlgHook: ExpDlgHookProcPtr;
  329.                                  filterProc: ExpModalFilterProcPtr;
  330.                                  yourDataPtr: UNIV Ptr): OSErr;
  331.     INLINE $303C,$0B3C,$A82D;
  332.  
  333.  
  334. {$ENDC}    { UsingEditions }
  335.  
  336. {$IFC NOT UsingIncludes}
  337.     END.
  338. {$ENDC}
  339.  
  340.